Skip to content

docs: pipeline: inputs: gpu-metrics: document NVIDIA NVML support and enable_nvml - #2630

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_in_gpu_metrics_updates
Jul 24, 2026
Merged

docs: pipeline: inputs: gpu-metrics: document NVIDIA NVML support and enable_nvml#2630
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_in_gpu_metrics_updates

Conversation

@eschabell

@eschabell eschabell commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator
  • Correct intro: NVIDIA GPUs are now supported via NVML (libnvidia-ml)
  • Add enable_nvml configuration option (default true)
  • Add gpu_process_memory_used_bytes and gpu_mig_device_info metrics
  • Note card/vendor labels (vendor: amd or nvidia)
  • Split GPU detection into AMD and NVIDIA subsections
  • Add enable_nvml to YAML and classic config examples

Note this action needed due to code changes without docs PR.

Summary by CodeRabbit

  • Documentation
    • Clarified GPU vendor support for AMD and NVIDIA, including Intel GPU limitations.
    • Documented additional NVIDIA metrics for process memory usage and MIG devices.
    • Clarified that metrics include card and vendor labels.
    • Added NVML configuration guidance and updated examples.
    • Documented automatic detection of supported AMD and NVIDIA GPUs, with filtering options.

@eschabell eschabell self-assigned this Jul 24, 2026
@eschabell
eschabell requested a review from a team as a code owner July 24, 2026 08:12
@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Jul 24, 2026
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@eschabell, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 37 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d28b0d7a-3954-45d1-961e-769c4795802e

📥 Commits

Reviewing files that changed from the base of the PR and between 6daf88b and 964ecdc.

📒 Files selected for processing (1)
  • pipeline/inputs/gpu-metrics.md
📝 Walkthrough

Walkthrough

The GPU metrics guide now documents AMD and NVIDIA support, NVIDIA-specific metrics, NVML configuration and fallback behavior, detection of supported cards, filtering options, and NVML-enabled YAML and Fluent Bit configuration examples.

Changes

GPU metrics documentation

Layer / File(s) Summary
Vendor support and metric coverage
pipeline/inputs/gpu-metrics.md
Documents AMD and NVIDIA collection methods, excludes Intel GPUs, adds NVIDIA process-memory and MIG metrics, and clarifies card and vendor labels.
NVML configuration and GPU detection
pipeline/inputs/gpu-metrics.md
Adds enable_nvml, describes missing-library behavior and multi-GPU detection, and updates both configuration examples. об

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested labels: 4.2.1

Suggested reviewers: patrick-stephens

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main documentation update about NVIDIA NVML support and the new enable_nvml option.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cosmo0920 cosmo0920 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For technical view points, it looks good to me! 👍

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/inputs/gpu-metrics.md`:
- Around line 94-96: Clarify the GPU filter documentation so NVIDIA values for
cards_include, cards_exclude, and the card label are selected using NVML
enumeration from nvidia-smi -L, distinct from AMD/sysfs /sys/class/drm/card*
names. Add the explicit command before explaining how to choose NVIDIA filter
values, without changing the existing parameter behavior.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9b013f7f-7988-4b85-92a4-7f6a6f0d4b43

📥 Commits

Reviewing files that changed from the base of the PR and between 4817e05 and 6daf88b.

📒 Files selected for processing (1)
  • pipeline/inputs/gpu-metrics.md

Comment thread pipeline/inputs/gpu-metrics.md Outdated
… enable_nvml

- Correct intro: NVIDIA GPUs are now supported via NVML (libnvidia-ml)
- Add enable_nvml configuration option (default true)
- Add gpu_process_memory_used_bytes and gpu_mig_device_info metrics
- Note card/vendor labels (vendor: amd or nvidia)
- Split GPU detection into AMD and NVIDIA subsections
- Add enable_nvml to YAML and classic config examples
- Clarify per-vendor card filtering: AMD sysfs number vs NVIDIA NVML
  index (nvidia-smi -L); note NVIDIA card label is the GPU UUID

Note this action needed due to code changes without docs PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell force-pushed the erics_in_gpu_metrics_updates branch from 6daf88b to 964ecdc Compare July 24, 2026 08:25
@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@eschabell
eschabell merged commit 50ac9cb into fluent:master Jul 24, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jul 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants